package com.dongliusuo.orangeforms.webadmin.app.service;

import com.dongliusuo.orangeforms.webadmin.app.model.*;
import com.dongliusuo.orangeforms.common.core.object.CallResult;
import com.dongliusuo.orangeforms.common.core.base.service.IBaseService;

import java.util.*;

/**
 * 客户银行卡数据数据操作服务接口。
 *
 * @author DongLiusuo
 * @date 2025-01-08
 */
public interface CustomerAccountService extends IBaseService<CustomerAccount, Long> {

    /**
     * 保存新增对象。
     *
     * @param customerAccount 新增对象。
     * @return 返回新增对象。
     */
    CustomerAccount saveNew(CustomerAccount customerAccount);

    /**
     * 利用数据库的insertList语法，批量插入对象列表。
     *
     * @param customerAccountList 新增对象列表。
     */
    void saveNewBatch(List<CustomerAccount> customerAccountList);

    /**
     * 利用数据库的insertList语法，批量插入对象列表。通常适用于更大的插入数据量，如批量导入。
     *
     * @param customerAccountList 新增对象列表。
     * @param batchSize  每批插入的数量。如果该值小于等于0，则使用缺省值10000。
     */
    void saveNewBatch(List<CustomerAccount> customerAccountList, int batchSize);

    /**
     * 更新数据对象。
     *
     * @param customerAccount         更新的对象。
     * @param originalCustomerAccount 原有数据对象。
     * @return 成功返回true，否则false。
     */
    boolean update(CustomerAccount customerAccount, CustomerAccount originalCustomerAccount);

    /**
     * 删除指定数据。
     *
     * @param accountId 主键Id。
     * @return 成功返回true，否则false。
     */
    boolean remove(Long accountId);

    /**
     * 当前服务的支持表为从表，根据主表的关联Id，删除一对多的从表数据。
     *
     * @param customerId 从表关联字段。
     * @return 删除数量。
     */
    int removeByCustomerId(Long customerId);

    /**
     * 批量更新一对多从表的数据。
     *
     * @param customerId 从表关联字段。
     * @param dataList 本次批量更新的一对多从表数据。
     */
    void updateBatchByCustomerId(Long customerId, List<CustomerAccount> dataList);

    /**
     * 获取单表查询结果。由于没有关联数据查询，因此在仅仅获取单表数据的场景下，效率更高。
     * 如果需要同时获取关联数据，请移步(getCustomerAccountListWithRelation)方法。
     *
     * @param filter  过滤对象。
     * @param orderBy 排序参数。
     * @return 查询结果集。
     */
    List<CustomerAccount> getCustomerAccountList(CustomerAccount filter, String orderBy);

    /**
     * 获取主表的查询结果，以及主表关联的字典数据和一对一从表数据，以及一对一从表的字典数据。
     * 该查询会涉及到一对一从表的关联过滤，或一对多从表的嵌套关联过滤，因此性能不如单表过滤。
     * 如果仅仅需要获取主表数据，请移步(getCustomerAccountList)，以便获取更好的查询性能。
     *
     * @param filter 主表过滤对象。
     * @param orderBy 排序参数。
     * @return 查询结果集。
     */
    List<CustomerAccount> getCustomerAccountListWithRelation(CustomerAccount filter, String orderBy);

    /**
     * 获取分组过滤后的数据查询结果，以及关联的字典数据和一对一从表数据，以及一对一从表的字典数据。
     *
     * @param filter      过滤对象。
     * @param groupSelect 分组显示列表参数。位于SQL语句SELECT的后面。
     * @param groupBy     分组参数。位于SQL语句的GROUP BY后面。
     * @param orderBy     排序字符串，ORDER BY从句的参数。
     * @return 分组过滤结果集。
     */
    List<CustomerAccount> getGroupedCustomerAccountListWithRelation(
            CustomerAccount filter, String groupSelect, String groupBy, String orderBy);

    /**
     * 对批量导入数据列表进行数据合法性验证。
     * 验证逻辑主要覆盖主表的常量字典字段、字典表字典字段、数据源字段和一对一关联数据是否存在。
     *
     * @param dataList 主表的数据列表。
     * @param ignoreFieldSet 需要忽略校验的字典字段集合。通常对于字典反向翻译过来的字段适用，
     *                       避免了二次验证，以提升效率。
     * @return 验证结果。如果失败，包含具体的错误信息和导致错误的数据对象。
     */
    CallResult verifyImportList(List<CustomerAccount> dataList, Set<String> ignoreFieldSet);
}
